Disable libostree docs
authorFelix Krull <f_krull@gmx.de>
Wed, 17 Oct 2018 21:18:55 +0000 (23:18 +0200)
committerColin Walters <walters@verbum.org>
Fri, 6 May 2022 16:53:53 +0000 (12:53 -0400)
The API docs are LGPL2 which, if we're being strict, would make the
entire result LGPL2 if the docs are included in the binary; I assume, at
least gtk-rs makes a point to not include the docs in the main build. It
should be possible to make a build script and associated feature that
includes the API docs just for the docs build.

rust-bindings/rust/Makefile

index c1dfa142448792ae46c0dbe901d868a8f387db03..4dfc942c9dbcc61bb743040c28d368cee90724e2 100644 (file)
@@ -15,16 +15,16 @@ gir/%: tools/bin/gir
 
 generate-libostree-sys: gir/libostree-sys
 
-generate-libostree: gir/libostree update-docs
+generate-libostree: gir/libostree #update-docs
 
 # docs
 update-docs: tools/bin/gir tools/bin/rustdoc-stripper
        tools/bin/gir -c conf/libostree.toml -m doc
-       sed -i \
-               -e "s/trait RepoExt::fn list_refs/trait RepoExtManual::fn list_refs/" \
-               -e "s/trait RepoExt::fn list_refs_ext/trait RepoExtManual::fn list_refs_ext/" \
-               -e "s/trait RepoExt::fn traverse_commit/trait RepoExtManual::fn traverse_commit/" \
-               libostree/vendor.md
+       #sed -i \
+       #       -e "s/trait RepoExt::fn list_refs/trait RepoExtManual::fn list_refs/" \
+       #       -e "s/trait RepoExt::fn list_refs_ext/trait RepoExtManual::fn list_refs_ext/" \
+       #       -e "s/trait RepoExt::fn traverse_commit/trait RepoExtManual::fn traverse_commit/" \
+       #       libostree/vendor.md
        tools/bin/rustdoc-stripper -g -o libostree/vendor.md
        rm libostree/vendor.md